Search operations
Search for facet values
Searches for values of a specified facet attribute.
- By default, facet values are sorted by decreasing count.
You can adjust this with the
sortFacetValueBy
parameter. - Searching for facet values doesn’t work if you have more than 65 searchable facets and searchable attributes combined.
POST
Authorizations
Your Algolia application ID.
Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.
Path Parameters
Name of the index on which to perform the operation.
Example:
"ALGOLIA_INDEX_NAME"
Facet attribute in which to search for values.
This attribute must be included in the attributesForFaceting
index setting with the searchable()
modifier.
Body
application/json
Response
200
application/json
OK
The response is of type object
.